home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / u_man / cat3 / Tk / message.z / message
Encoding:
Text File  |  1998-10-30  |  10.7 KB  |  199 lines
  1.  
  2.  
  3.  
  4. mmmmeeeessssssssaaaaggggeeee((((3333TTTTkkkk))))                                                      mmmmeeeessssssssaaaaggggeeee((((3333TTTTkkkk))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      message - Create and manipulate message widgets
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      mmmmeeeessssssssaaaaggggeeee _p_a_t_h_N_a_m_e ?_o_p_t_i_o_n_s?
  13.  
  14. SSSSTTTTAAAANNNNDDDDAAAARRRRDDDD OOOOPPPPTTTTIIIIOOOONNNNSSSS
  15.      aaaannnncccchhhhoooorrrr       ffffoooonnnntttt                 hhhhiiiigggghhhhlllliiiigggghhhhttttTTTThhhhiiiicccckkkknnnneeeessssssss  ttttaaaakkkkeeeeFFFFooooccccuuuussss          |
  16.      bbbbaaaacccckkkkggggrrrroooouuuunnnndddd   ffffoooorrrreeeeggggrrrroooouuuunnnndddd           ppppaaaaddddXXXX                tttteeeexxxxtttt               |
  17.      bbbboooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh  hhhhiiiigggghhhhlllliiiigggghhhhttttBBBBaaaacccckkkkggggrrrroooouuuunnnndddd  ppppaaaaddddYYYY                tttteeeexxxxttttVVVVaaaarrrriiiiaaaabbbblllleeee       |
  18.      ccccuuuurrrrssssoooorrrr       hhhhiiiigggghhhhlllliiiigggghhhhttttCCCCoooolllloooorrrr       rrrreeeelllliiiieeeeffff              wwwwiiiiddddtttthhhh
  19.  
  20.      See the ``options'' manual entry for details on the standard options.
  21.  
  22. WWWWIIIIDDDDGGGGEEEETTTT----SSSSPPPPEEEECCCCIIIIFFFFIIIICCCC OOOOPPPPTTTTIIIIOOOONNNNSSSS
  23.      Name:           aaaassssppppeeeecccctttt
  24.      Class:          AAAAssssppppeeeecccctttt
  25.      Command-Line Switch:----aaaassssppppeeeecccctttt
  26.  
  27.           Specifies a non-negative integer value indicating desired aspect
  28.           ratio for the text.  The aspect ratio is specified as
  29.           100*width/height.  100 means the text should be as wide as it is
  30.           tall, 200 means the text should be twice as wide as it is tall, 50
  31.           means the text should be twice as tall as it is wide, and so on.
  32.           Used to choose line length for text if wwwwiiiiddddtttthhhh option isn't specified.
  33.           Defaults to 150.
  34.  
  35.      Name:           jjjjuuuussssttttiiiiffffyyyy
  36.      Class:          JJJJuuuussssttttiiiiffffyyyy
  37.      Command-Line Switch:----jjjjuuuussssttttiiiiffffyyyy
  38.  
  39.           Specifies how to justify lines of text.  Must be one of lllleeeefffftttt,
  40.           cccceeeennnntttteeeerrrr, or rrrriiiigggghhhhtttt.  Defaults to lllleeeefffftttt.  This option works together
  41.           with the aaaannnncccchhhhoooorrrr, aaaassssppppeeeecccctttt, ppppaaaaddddXXXX, ppppaaaaddddYYYY, and wwwwiiiiddddtttthhhh options to provide a
  42.           variety of arrangements of the text within the window.  The aaaassssppppeeeecccctttt
  43.           and wwwwiiiiddddtttthhhh options determine the amount of screen space needed to
  44.           display the text.  The aaaannnncccchhhhoooorrrr, ppppaaaaddddXXXX, and ppppaaaaddddYYYY options determine
  45.           where this rectangular area is displayed within the widget's window,
  46.           and the jjjjuuuussssttttiiiiffffyyyy option determines how each line is displayed within
  47.           that rectangular region.  For example, suppose aaaannnncccchhhhoooorrrr is eeee and
  48.           jjjjuuuussssttttiiiiffffyyyy is lllleeeefffftttt, and that the message window is much larger than
  49.           needed for the text.  The the text will displayed so that the left
  50.           edges of all the lines line up and the right edge of the longest
  51.           line is ppppaaaaddddXXXX from the right side of the window;  the entire text
  52.           block will be centered in the vertical span of the window.
  53.  
  54.      Name:           wwwwiiiiddddtttthhhh
  55.      Class:          WWWWiiiiddddtttthhhh
  56.      Command-Line Switch:----wwwwiiiiddddtttthhhh
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. mmmmeeeessssssssaaaaggggeeee((((3333TTTTkkkk))))                                                      mmmmeeeessssssssaaaaggggeeee((((3333TTTTkkkk))))
  71.  
  72.  
  73.  
  74.           Specifies the length of lines in the window.  The value may have any
  75.           of the forms acceptable to TTTTkkkk____GGGGeeeettttPPPPiiiixxxxeeeellllssss.  If this option has a value
  76.           greater than zero then the aaaassssppppeeeecccctttt option is ignored and the wwwwiiiiddddtttthhhh
  77.           option determines the line length.  If this option has a value less
  78.           than or equal to zero, then the aaaassssppppeeeecccctttt option determines the line
  79.           length.
  80.  
  81.  
  82. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  83.      The mmmmeeeessssssssaaaaggggeeee command creates a new window (given by the _p_a_t_h_N_a_m_e argument)
  84.      and makes it into a message widget.  Additional options, described above,
  85.      may be specified on the command line or in the option database to
  86.      configure aspects of the message such as its colors, font, text, and
  87.      initial relief.  The mmmmeeeessssssssaaaaggggeeee command returns its _p_a_t_h_N_a_m_e argument.  At
  88.      the time this command is invoked, there must not exist a window named
  89.      _p_a_t_h_N_a_m_e, but _p_a_t_h_N_a_m_e's parent must exist.
  90.  
  91.      A message is a widget that displays a textual string.  A message widget
  92.      has three special features.  First, it breaks up its string into lines in
  93.      order to produce a given aspect ratio for the window.  The line breaks
  94.      are chosen at word boundaries wherever possible (if not even a single
  95.      word would fit on a line, then the word will be split across lines).
  96.      Newline characters in the string will force line breaks;  they can be
  97.      used, for example, to leave blank lines in the display.
  98.  
  99.      The second feature of a message widget is justification.  The text may be
  100.      displayed left-justified (each line starts at the left side of the
  101.      window), centered on a line-by-line basis, or right-justified (each line
  102.      ends at the right side of the window).
  103.  
  104.      The third feature of a message widget is that it handles control
  105.      characters and non-printing characters specially.  Tab characters are
  106.      replaced with enough blank space to line up on the next 8-character
  107.      boundary.  Newlines cause line breaks.  Other control characters (ASCII
  108.      code less than 0x20) and characters not defined in the font are displayed
  109.      as a four-character sequence \\\\xxxx_h_h where _h_h is the two-digit hexadecimal
  110.      number corresponding to the character.  In the unusual case where the
  111.      font doesn't contain all of the characters in ``0123456789abcdef\x'' then
  112.      control characters and undefined characters are not displayed at all.
  113.  
  114.  
  115. WWWWIIIIDDDDGGGGEEEETTTT CCCCOOOOMMMMMMMMAAAANNNNDDDD
  116.      The mmmmeeeessssssssaaaaggggeeee command creates a new Tcl command whose name is _p_a_t_h_N_a_m_e.
  117.      This command may be used to invoke various operations on the widget.  It
  118.      has the following general form:
  119.  
  120.           _p_a_t_h_N_a_m_e _o_p_t_i_o_n ?_a_r_g _a_r_g ...?
  121.  
  122.      _O_p_t_i_o_n and the _a_r_gs determine the exact behavior of the command.  The
  123.      following commands are possible for message widgets:
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. mmmmeeeessssssssaaaaggggeeee((((3333TTTTkkkk))))                                                      mmmmeeeessssssssaaaaggggeeee((((3333TTTTkkkk))))
  137.  
  138.  
  139.  
  140.      _p_a_t_h_N_a_m_e ccccggggeeeetttt _o_p_t_i_o_n
  141.           Returns the current value of the configuration option given by      |
  142.           _o_p_t_i_o_n.  _O_p_t_i_o_n may have any of the values accepted by the mmmmeeeessssssssaaaaggggeeee  |
  143.           command.
  144.  
  145.      _p_a_t_h_N_a_m_e ccccoooonnnnffffiiiigggguuuurrrreeee ?_o_p_t_i_o_n? ?_v_a_l_u_e _o_p_t_i_o_n _v_a_l_u_e ...?
  146.           Query or modify the configuration options of the widget.  If no
  147.           _o_p_t_i_o_n is specified, returns a list describing all of the available
  148.           options for _p_a_t_h_N_a_m_e (see TTTTkkkk____CCCCoooonnnnffffiiiigggguuuurrrreeeeIIIInnnnffffoooo for information on the
  149.           format of this list).  If _o_p_t_i_o_n is specified with no _v_a_l_u_e, then
  150.           the command returns a list describing the one named option (this
  151.           list will be identical to the corresponding sublist of the value
  152.           returned if no _o_p_t_i_o_n is specified).  If one or more _o_p_t_i_o_n-_v_a_l_u_e
  153.           pairs are specified, then the command modifies the given widget
  154.           option(s) to have the given value(s);  in this case the command
  155.           returns an empty string.  _O_p_t_i_o_n may have any of the values accepted
  156.           by the mmmmeeeessssssssaaaaggggeeee command.
  157.  
  158.  
  159. DDDDEEEEFFFFAAAAUUUULLLLTTTT BBBBIIIINNNNDDDDIIIINNNNGGGGSSSS
  160.      When a new message is created, it has no default event bindings:
  161.      messages are intended for output purposes only.
  162.  
  163.  
  164. BBBBUUUUGGGGSSSS
  165.      Tabs don't work very well with text that is centered or right-justified.
  166.      The most common result is that the line is justified wrong.
  167.  
  168.  
  169. KKKKEEEEYYYYWWWWOOOORRRRDDDDSSSS
  170.      message, widget
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.